<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: ipc::transport::Blob_stream_mq_receiver&lt; Persistent_mq_handle &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceipc.html">ipc</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1transport.html">transport</a></li><li class="navelem"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">Blob_stream_mq_receiver</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#pri-types">Private Types</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="#related">Related Functions</a> &#124;
<a href="classipc_1_1transport_1_1Blob__stream__mq__receiver-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ipc::transport::Blob_stream_mq_receiver&lt; Persistent_mq_handle &gt; Class Template Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Implements <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Blob_receiver</a> concept by using an adopted <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html" title="A documentation-only concept defining the behavior of an object representing a light-weight handle to...">Persistent_mq_handle</a> MQ handle to an MQ (message queue) of that type, such as a POSIX or bipc MQ.  
 <a href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="blob__stream__mq__rcv_8hpp_source.html">blob_stream_mq_rcv.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ipc::transport::Blob_stream_mq_receiver&lt; Persistent_mq_handle &gt;:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classipc_1_1transport_1_1Blob__stream__mq__receiver__inherit__graph.svg" width="196" height="155"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ipc::transport::Blob_stream_mq_receiver&lt; Persistent_mq_handle &gt;:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classipc_1_1transport_1_1Blob__stream__mq__receiver__coll__graph.svg" width="995" height="360"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ad9b78b2744b2c97f2e2e7039d724f8da"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#ad9b78b2744b2c97f2e2e7039d724f8da">Mq</a> = typename <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver__impl.html">Blob_stream_mq_receiver_impl</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt;::Mq</td></tr>
<tr class="memdesc:ad9b78b2744b2c97f2e2e7039d724f8da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Short-hand for template arg for underlying MQ handle type.  <a href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#ad9b78b2744b2c97f2e2e7039d724f8da">More...</a><br /></td></tr>
<tr class="separator:ad9b78b2744b2c97f2e2e7039d724f8da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0b92945d8282046d5fafa8230f84b93"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#aa0b92945d8282046d5fafa8230f84b93">Sync_io_obj</a> = <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__stream__mq__receiver.html">sync_io::Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#ad9b78b2744b2c97f2e2e7039d724f8da">Mq</a> &gt;</td></tr>
<tr class="memdesc:aa0b92945d8282046d5fafa8230f84b93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Useful for generic programming, the <code><a class="el" href="namespaceipc_1_1transport_1_1sync__io.html" title="sync_io-pattern counterparts to async-I/O-pattern object types in parent namespace ipc::transport.">sync_io</a></code>-pattern counterpart to <code>*this</code> type.  <a href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#aa0b92945d8282046d5fafa8230f84b93">More...</a><br /></td></tr>
<tr class="separator:aa0b92945d8282046d5fafa8230f84b93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56785a83d2f4669ed4bd40d5247941bd"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a56785a83d2f4669ed4bd40d5247941bd">Async_io_obj</a> = <a class="el" href="classipc_1_1transport_1_1Null__peer.html">Null_peer</a></td></tr>
<tr class="memdesc:a56785a83d2f4669ed4bd40d5247941bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">You may disregard.  <a href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a56785a83d2f4669ed4bd40d5247941bd">More...</a><br /></td></tr>
<tr class="separator:a56785a83d2f4669ed4bd40d5247941bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9c2318ec5a002788fb6e21b89b6126f9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a9c2318ec5a002788fb6e21b89b6126f9">Blob_stream_mq_receiver</a> (flow::log::Logger *logger_ptr, <a class="el" href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">util::String_view</a> nickname_str, <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#ad9b78b2744b2c97f2e2e7039d724f8da">Mq</a> &amp;&amp;mq_moved, <a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> *err_code=0)</td></tr>
<tr class="memdesc:a9c2318ec5a002788fb6e21b89b6126f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs the receiver by taking over an already-opened MQ handle.  <a href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a9c2318ec5a002788fb6e21b89b6126f9">More...</a><br /></td></tr>
<tr class="separator:a9c2318ec5a002788fb6e21b89b6126f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ae41d506252eae388877ae8a81509d2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a5ae41d506252eae388877ae8a81509d2">Blob_stream_mq_receiver</a> (<a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#aa0b92945d8282046d5fafa8230f84b93">Sync_io_obj</a> &amp;&amp;sync_io_core_in_peer_state_moved)</td></tr>
<tr class="memdesc:a5ae41d506252eae388877ae8a81509d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Blob_receiver</a> API, per its concept contract.  <a href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a5ae41d506252eae388877ae8a81509d2">More...</a><br /></td></tr>
<tr class="separator:a5ae41d506252eae388877ae8a81509d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37990d73f81ac8c98780d19e0ddf825c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a37990d73f81ac8c98780d19e0ddf825c">Blob_stream_mq_receiver</a> ()</td></tr>
<tr class="memdesc:a37990d73f81ac8c98780d19e0ddf825c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Blob_receiver</a> API, per its concept contract.  <a href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a37990d73f81ac8c98780d19e0ddf825c">More...</a><br /></td></tr>
<tr class="separator:a37990d73f81ac8c98780d19e0ddf825c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c2643bdf07b05b2ad4629ead2ae44e7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a6c2643bdf07b05b2ad4629ead2ae44e7">Blob_stream_mq_receiver</a> (<a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">Blob_stream_mq_receiver</a> &amp;&amp;src)</td></tr>
<tr class="memdesc:a6c2643bdf07b05b2ad4629ead2ae44e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move-constructs from <code>src</code>; <code>src</code> becomes as-if default-cted (therefore in NULL state).  <a href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a6c2643bdf07b05b2ad4629ead2ae44e7">More...</a><br /></td></tr>
<tr class="separator:a6c2643bdf07b05b2ad4629ead2ae44e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b2362e1945eca2e978b75151893deca"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a3b2362e1945eca2e978b75151893deca">~Blob_stream_mq_receiver</a> ()</td></tr>
<tr class="memdesc:a3b2362e1945eca2e978b75151893deca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Blob_receiver</a> API.  <a href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a3b2362e1945eca2e978b75151893deca">More...</a><br /></td></tr>
<tr class="separator:a3b2362e1945eca2e978b75151893deca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34d07384ebb52b1a5e07684817033705"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">Blob_stream_mq_receiver</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a34d07384ebb52b1a5e07684817033705">operator=</a> (<a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">Blob_stream_mq_receiver</a> &amp;&amp;src)</td></tr>
<tr class="memdesc:a34d07384ebb52b1a5e07684817033705"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move-assigns from <code>src</code>; <code>*this</code> acts as if destructed; <code>src</code> becomes as-if default-cted (therefore in NULL state).  <a href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a34d07384ebb52b1a5e07684817033705">More...</a><br /></td></tr>
<tr class="separator:a34d07384ebb52b1a5e07684817033705"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaef06fc407e90aea1a1e5fb52c6e0845"><td class="memItemLeft" align="right" valign="top"><a id="aaef06fc407e90aea1a1e5fb52c6e0845" name="aaef06fc407e90aea1a1e5fb52c6e0845"></a>
<a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">Blob_stream_mq_receiver</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">Blob_stream_mq_receiver</a> &amp;)=delete</td></tr>
<tr class="memdesc:aaef06fc407e90aea1a1e5fb52c6e0845"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy assignment is disallowed. <br /></td></tr>
<tr class="separator:aaef06fc407e90aea1a1e5fb52c6e0845"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54aba7a6660a9290ca9e91c06dc18985"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a54aba7a6660a9290ca9e91c06dc18985">receive_blob_max_size</a> () const</td></tr>
<tr class="memdesc:a54aba7a6660a9290ca9e91c06dc18985"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Blob_receiver</a> API per contract.  <a href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a54aba7a6660a9290ca9e91c06dc18985">More...</a><br /></td></tr>
<tr class="separator:a54aba7a6660a9290ca9e91c06dc18985"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abf9cd5543b367fd68aaefc6241c9287f"><td class="memTemplParams" colspan="2">template&lt;typename Task_err_sz &gt; </td></tr>
<tr class="memitem:abf9cd5543b367fd68aaefc6241c9287f"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#abf9cd5543b367fd68aaefc6241c9287f">async_receive_blob</a> (const <a class="el" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a> &amp;target_blob, Task_err_sz &amp;&amp;on_done_func)</td></tr>
<tr class="memdesc:abf9cd5543b367fd68aaefc6241c9287f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Blob_receiver</a> API per contract.  <a href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#abf9cd5543b367fd68aaefc6241c9287f">More...</a><br /></td></tr>
<tr class="separator:abf9cd5543b367fd68aaefc6241c9287f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a444ed00ac6f4375a1bb65d0cd036b493"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a444ed00ac6f4375a1bb65d0cd036b493">idle_timer_run</a> (<a class="el" href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">util::Fine_duration</a> timeout=boost::chrono::seconds(5))</td></tr>
<tr class="memdesc:a444ed00ac6f4375a1bb65d0cd036b493"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Blob_receiver</a> API per contract.  <a href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a444ed00ac6f4375a1bb65d0cd036b493">More...</a><br /></td></tr>
<tr class="separator:a444ed00ac6f4375a1bb65d0cd036b493"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a295c5724fedb49581506f49265d7c91a"><td class="memItemLeft" align="right" valign="top">const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a295c5724fedb49581506f49265d7c91a">nickname</a> () const</td></tr>
<tr class="memdesc:a295c5724fedb49581506f49265d7c91a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns nickname, a brief string suitable for logging.  <a href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a295c5724fedb49581506f49265d7c91a">More...</a><br /></td></tr>
<tr class="separator:a295c5724fedb49581506f49265d7c91a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33770c19a8e809be10aed37f366708d8"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="namespaceipc_1_1transport.html#a33de1c256addb3964b839dc2dd407d24">Shared_name</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a33770c19a8e809be10aed37f366708d8">absolute_name</a> () const</td></tr>
<tr class="memdesc:a33770c19a8e809be10aed37f366708d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns name equal to <code>mq.absolute_name()</code>, where <code>mq</code> was passed to ctor, at the time it was passed to ctor.  <a href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a33770c19a8e809be10aed37f366708d8">More...</a><br /></td></tr>
<tr class="separator:a33770c19a8e809be10aed37f366708d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:ae7d533fef03e83c06b4b5071d3427bbd"><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="namespaceipc_1_1transport.html#a33de1c256addb3964b839dc2dd407d24">Shared_name</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#ae7d533fef03e83c06b4b5071d3427bbd">S_RESOURCE_TYPE_ID</a> = Mq::S_RESOURCE_TYPE_ID</td></tr>
<tr class="memdesc:ae7d533fef03e83c06b4b5071d3427bbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements concept API. Equals <code>Mq::S_RESOURCE_TYPE_ID</code>.  <a href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#ae7d533fef03e83c06b4b5071d3427bbd">More...</a><br /></td></tr>
<tr class="separator:ae7d533fef03e83c06b4b5071d3427bbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29896e21893ae99c9f0d90a11606f819"><td class="memItemLeft" align="right" valign="top">static constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a29896e21893ae99c9f0d90a11606f819">S_BLOB_UNDERFLOW_ALLOWED</a> = false</td></tr>
<tr class="memdesc:a29896e21893ae99c9f0d90a11606f819"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements concept API; namely it is <code>true</code>.  <a href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a29896e21893ae99c9f0d90a11606f819">More...</a><br /></td></tr>
<tr class="separator:a29896e21893ae99c9f0d90a11606f819"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-types" name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:a2356c1b82f534d17e3a7a8e00023d08c"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a2356c1b82f534d17e3a7a8e00023d08c">Impl_ptr</a> = std::experimental::propagate_const&lt; boost::movelib::unique_ptr&lt; <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver__impl.html">Blob_stream_mq_receiver_impl</a>&lt; <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#ad9b78b2744b2c97f2e2e7039d724f8da">Mq</a> &gt; &gt; &gt;</td></tr>
<tr class="memdesc:a2356c1b82f534d17e3a7a8e00023d08c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Short-hand for <code>const</code>-respecting wrapper around <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__sender__impl.html" title="Internal, non-movable pImpl-lite implementation of Blob_stream_mq_sender class template.">Blob_stream_mq_sender_impl</a> for the pImpl idiom.  <a href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a2356c1b82f534d17e3a7a8e00023d08c">More...</a><br /></td></tr>
<tr class="separator:a2356c1b82f534d17e3a7a8e00023d08c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a181eb6e9705b8787bb238174da1b6e51"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a2356c1b82f534d17e3a7a8e00023d08c">Impl_ptr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a181eb6e9705b8787bb238174da1b6e51">m_impl</a></td></tr>
<tr class="memdesc:a181eb6e9705b8787bb238174da1b6e51"><td class="mdescLeft">&#160;</td><td class="mdescRight">The true implementation of this class. See also our class doc header.  <a href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a181eb6e9705b8787bb238174da1b6e51">More...</a><br /></td></tr>
<tr class="separator:a181eb6e9705b8787bb238174da1b6e51"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ae7eb37827da4c05e8dfaf0124612bb08"><td class="memTemplParams" colspan="2"><a id="ae7eb37827da4c05e8dfaf0124612bb08" name="ae7eb37827da4c05e8dfaf0124612bb08"></a>
template&lt;typename Persistent_mq_handle2 &gt; </td></tr>
<tr class="memitem:ae7eb37827da4c05e8dfaf0124612bb08"><td class="memTemplItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><b>operator&lt;&lt;</b> (std::ostream &amp;os, const <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">Blob_stream_mq_receiver</a>&lt; Persistent_mq_handle2 &gt; &amp;val)</td></tr>
<tr class="memdesc:ae7eb37827da4c05e8dfaf0124612bb08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Friend of <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__sender.html" title="Implements Blob_sender concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message q...">Blob_stream_mq_sender</a>. <br /></td></tr>
<tr class="separator:ae7eb37827da4c05e8dfaf0124612bb08"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="related" name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p >(Note that these are not member functions.) </p>
</td></tr>
<tr class="memitem:a65a95c466144d63ce3f7f11f554a335c"><td class="memTemplParams" colspan="2">template&lt;typename <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; </td></tr>
<tr class="memitem:a65a95c466144d63ce3f7f11f554a335c"><td class="memTemplItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a65a95c466144d63ce3f7f11f554a335c">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; &amp;val)</td></tr>
<tr class="memdesc:a65a95c466144d63ce3f7f11f554a335c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints string representation of the given <code><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html" title="Implements Blob_receiver concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message...">Blob_stream_mq_receiver</a></code> to the given <code>ostream</code>.  <a href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a65a95c466144d63ce3f7f11f554a335c">More...</a><br /></td></tr>
<tr class="separator:a65a95c466144d63ce3f7f11f554a335c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classipc_1_1transport_1_1Blob__stream__mq__base"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classipc_1_1transport_1_1Blob__stream__mq__base')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__base.html">ipc::transport::Blob_stream_mq_base&lt; Persistent_mq_handle &gt;</a></td></tr>
<tr class="memitem:ac1230ff7e73783da730b8639c30511e2 inherit pub_static_methods_classipc_1_1transport_1_1Blob__stream__mq__base"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__base.html#ac1230ff7e73783da730b8639c30511e2">remove_persistent</a> (flow::log::Logger *logger_ptr, const <a class="el" href="namespaceipc_1_1transport.html#a33de1c256addb3964b839dc2dd407d24">Shared_name</a> &amp;name, <a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> *err_code=0)</td></tr>
<tr class="memdesc:ac1230ff7e73783da730b8639c30511e2 inherit pub_static_methods_classipc_1_1transport_1_1Blob__stream__mq__base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes the <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__sender.html" title="Implements Blob_sender concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message q...">Blob_stream_mq_sender</a> and/or <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html" title="Implements Blob_receiver concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message...">Blob_stream_mq_receiver</a> persistent resources associated with a <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html" title="A documentation-only concept defining the behavior of an object representing a light-weight handle to...">Persistent_mq_handle</a> with the given name.  <a href="classipc_1_1transport_1_1Blob__stream__mq__base.html#ac1230ff7e73783da730b8639c30511e2">More...</a><br /></td></tr>
<tr class="separator:ac1230ff7e73783da730b8639c30511e2 inherit pub_static_methods_classipc_1_1transport_1_1Blob__stream__mq__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ef2c620fae98180ecd482f0093da44f inherit pub_static_methods_classipc_1_1transport_1_1Blob__stream__mq__base"><td class="memTemplParams" colspan="2">template&lt;typename Handle_name_func &gt; </td></tr>
<tr class="memitem:a8ef2c620fae98180ecd482f0093da44f inherit pub_static_methods_classipc_1_1transport_1_1Blob__stream__mq__base"><td class="memTemplItemLeft" align="right" valign="top">static void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__base.html#a8ef2c620fae98180ecd482f0093da44f">for_each_persistent</a> (const Handle_name_func &amp;handle_name_func)</td></tr>
<tr class="memdesc:a8ef2c620fae98180ecd482f0093da44f inherit pub_static_methods_classipc_1_1transport_1_1Blob__stream__mq__base"><td class="mdescLeft">&#160;</td><td class="mdescRight">Forwards to <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html#ac14dd419cdbc97b6630900268f8b7dd2" title="Lists all named persistent MQs currently persisting, invoking the given handler synchronously on each...">Persistent_mq_handle::for_each_persistent()</a>.  <a href="classipc_1_1transport_1_1Blob__stream__mq__base.html#a8ef2c620fae98180ecd482f0093da44f">More...</a><br /></td></tr>
<tr class="separator:a8ef2c620fae98180ecd482f0093da44f inherit pub_static_methods_classipc_1_1transport_1_1Blob__stream__mq__base"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><div class="compoundTemplParams">template&lt;typename <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a>&gt;<br />
class ipc::transport::Blob_stream_mq_receiver&lt; Persistent_mq_handle &gt;</div><p >Implements <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Blob_receiver</a> concept by using an adopted <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html" title="A documentation-only concept defining the behavior of an object representing a light-weight handle to...">Persistent_mq_handle</a> MQ handle to an MQ (message queue) of that type, such as a POSIX or bipc MQ. </p>
<p >This allows for high-performance, potentially zero-copy (except for copying out of the transport MQ) of discrete messages, each containing a binary blob. This is a low-level (core) transport mechanism; higher-level (structured) transport mechanisms may use <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html" title="Implements Blob_receiver concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message...">Blob_stream_mq_receiver</a> (and <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__sender.html" title="Implements Blob_sender concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message q...">Blob_stream_mq_sender</a>) to enable their work.</p>
<p >Beyond that: see <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__sender.html" title="Implements Blob_sender concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message q...">Blob_stream_mq_sender</a> doc header. We are just the other side of this.</p>
<h3>Cleanup; reusing same <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a33770c19a8e809be10aed37f366708d8" title="Returns name equal to mq.absolute_name(), where mq was passed to ctor, at the time it was passed to c...">absolute_name()</a></h3>
<p >See <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__sender.html" title="Implements Blob_sender concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message q...">Blob_stream_mq_sender</a> doc header. The same applies symmetrically.</p>
<h3>Performance, responsiveness</h3>
<p >See <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__sender.html" title="Implements Blob_sender concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message q...">Blob_stream_mq_sender</a> doc header. The same applies symmetrically. Be aware specifically that the same responsiveness-of-destructor caveat applies to <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html" title="Implements Blob_receiver concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message...">Blob_stream_mq_receiver</a>.</p>
<h3>Thread safety</h3>
<p >We add no more thread safety guarantees than those mandated by the main concepts. To wit:</p><ul>
<li>Concurrent access to 2 separate <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html" title="Implements Blob_receiver concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message...">Blob_stream_mq_receiver</a> objects is safe.</li>
<li>After construction, concurrent access to the main transmission API methods and the dtor is not safe for a given <code>*this</code>.</li>
</ul>
<p >Methods and situations not covered by that text should have their thread safety explained in their individual doc headers.</p>
<h3>Implementation design/rationale</h3>
<p >See pImpl-lite notes in <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__sender.html" title="Implements Blob_sender concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message q...">Blob_stream_mq_sender</a> doc header. The exact same applies here.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver__impl.html" title="Internal, non-movable pImpl-lite implementation of Blob_stream_mq_receiver class template.">Blob_stream_mq_receiver_impl</a> doc header.</dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname"><a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html" title="A documentation-only concept defining the behavior of an object representing a light-weight handle to...">Persistent_mq_handle</a></td><td>See <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html" title="A documentation-only concept defining the behavior of an object representing a light-weight handle to...">Persistent_mq_handle</a> concept doc header.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Blob_receiver</a>: implemented concept. </dd></dl>

<p class="definition">Definition at line <a class="el" href="blob__stream__mq__rcv_8hpp_source.html#l00069">69</a> of file <a class="el" href="blob__stream__mq__rcv_8hpp_source.html">blob_stream_mq_rcv.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a56785a83d2f4669ed4bd40d5247941bd" name="a56785a83d2f4669ed4bd40d5247941bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56785a83d2f4669ed4bd40d5247941bd">&#9670;&nbsp;</a></span>Async_io_obj</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">ipc::transport::Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt;::Async_io_obj =  <a class="el" href="classipc_1_1transport_1_1Null__peer.html">Null_peer</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>You may disregard. </p>

<p class="definition">Definition at line <a class="el" href="blob__stream__mq__rcv_8hpp_source.html#l00080">80</a> of file <a class="el" href="blob__stream__mq__rcv_8hpp_source.html">blob_stream_mq_rcv.hpp</a>.</p>

</div>
</div>
<a id="a2356c1b82f534d17e3a7a8e00023d08c" name="a2356c1b82f534d17e3a7a8e00023d08c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2356c1b82f534d17e3a7a8e00023d08c">&#9670;&nbsp;</a></span>Impl_ptr</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">ipc::transport::Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt;::Impl_ptr =  std::experimental::propagate_const&lt;boost::movelib::unique_ptr&lt;<a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver__impl.html">Blob_stream_mq_receiver_impl</a>&lt;<a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#ad9b78b2744b2c97f2e2e7039d724f8da">Mq</a>&gt; &gt;&gt;</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Short-hand for <code>const</code>-respecting wrapper around <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__sender__impl.html" title="Internal, non-movable pImpl-lite implementation of Blob_stream_mq_sender class template.">Blob_stream_mq_sender_impl</a> for the pImpl idiom. </p>

<p class="definition">Definition at line <a class="el" href="blob__stream__mq__rcv_8hpp_source.html#l00287">287</a> of file <a class="el" href="blob__stream__mq__rcv_8hpp_source.html">blob_stream_mq_rcv.hpp</a>.</p>

</div>
</div>
<a id="ad9b78b2744b2c97f2e2e7039d724f8da" name="ad9b78b2744b2c97f2e2e7039d724f8da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9b78b2744b2c97f2e2e7039d724f8da">&#9670;&nbsp;</a></span>Mq</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">ipc::transport::Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt;::Mq =  typename <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver__impl.html">Blob_stream_mq_receiver_impl</a>&lt;<a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a>&gt;::Mq</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Short-hand for template arg for underlying MQ handle type. </p>

<p class="definition">Definition at line <a class="el" href="blob__stream__mq__rcv_8hpp_source.html#l00075">75</a> of file <a class="el" href="blob__stream__mq__rcv_8hpp_source.html">blob_stream_mq_rcv.hpp</a>.</p>

</div>
</div>
<a id="aa0b92945d8282046d5fafa8230f84b93" name="aa0b92945d8282046d5fafa8230f84b93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0b92945d8282046d5fafa8230f84b93">&#9670;&nbsp;</a></span>Sync_io_obj</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">ipc::transport::Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt;::Sync_io_obj =  <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Blob__stream__mq__receiver.html">sync_io::Blob_stream_mq_receiver</a>&lt;<a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#ad9b78b2744b2c97f2e2e7039d724f8da">Mq</a>&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Useful for generic programming, the <code><a class="el" href="namespaceipc_1_1transport_1_1sync__io.html" title="sync_io-pattern counterparts to async-I/O-pattern object types in parent namespace ipc::transport.">sync_io</a></code>-pattern counterpart to <code>*this</code> type. </p>

<p class="definition">Definition at line <a class="el" href="blob__stream__mq__rcv_8hpp_source.html#l00078">78</a> of file <a class="el" href="blob__stream__mq__rcv_8hpp_source.html">blob_stream_mq_rcv.hpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9c2318ec5a002788fb6e21b89b6126f9" name="a9c2318ec5a002788fb6e21b89b6126f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c2318ec5a002788fb6e21b89b6126f9">&#9670;&nbsp;</a></span>Blob_stream_mq_receiver() <span class="overload">[1/4]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">ipc::transport::Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt;::Blob_stream_mq_receiver </td>
          <td>(</td>
          <td class="paramtype">flow::log::Logger *&#160;</td>
          <td class="paramname"><em>logger_ptr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">util::String_view</a>&#160;</td>
          <td class="paramname"><em>nickname_str</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#ad9b78b2744b2c97f2e2e7039d724f8da">Mq</a> &amp;&amp;&#160;</td>
          <td class="paramname"><em>mq_moved</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> *&#160;</td>
          <td class="paramname"><em>err_code</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Constructs the receiver by taking over an already-opened MQ handle. </p>
<p >Note that this op does not implement any concept; <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Blob_receiver</a> concept does not define how a <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Blob_receiver</a> is created in this explicit fashion.</p>
<p >No traffic must have occurred on <code>mq_moved</code> up to this call. Otherwise behavior is undefined.</p>
<p >If this fails (sets <code>*err_code</code> to truthy if not null; throws if null), all transmission calls on <code>*this</code> will fail with the post-value in <code>*err_code</code> emitted. In particular, <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297af6ee4717280d29cc272ef2a356ad3982" title="Message-queue blob stream incoming-direction peer could not be created, because one already exists at...">error::Code::S_BLOB_STREAM_MQ_RECEIVER_EXISTS</a> is that code, if the reason for failure was that another <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html" title="Implements Blob_receiver concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message...">Blob_stream_mq_receiver</a> to <code>mq_moved.absolute_name()</code> has already been created in this or other process. See <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__sender.html" title="Implements Blob_sender concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message q...">Blob_stream_mq_sender</a> class doc header for discussion of the relationship between <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__sender.html" title="Implements Blob_sender concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message q...">Blob_stream_mq_sender</a>, <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html" title="Implements Blob_receiver concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message...">Blob_stream_mq_receiver</a>, the underlying MQ at a given Shared_name, and that Shared_name as registered in the OS. In short: there is to be up to 1 <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__sender.html" title="Implements Blob_sender concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message q...">Blob_stream_mq_sender</a> and up to 1 <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html" title="Implements Blob_receiver concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message...">Blob_stream_mq_receiver</a> for a given named persistent MQ. In this way, it is one single-direction pipe with 2 peers, like half of <a class="el" href="classipc_1_1transport_1_1Native__socket__stream.html" title="Implements both Native_handle_sender and Native_handle_receiver concepts by using a stream-oriented U...">Native_socket_stream</a> pipe: it is not a MQ with back-and-forth traffic nor multiple senders or multiple receivers. The underlying MQ supports such things; but that is not what the Blob_sender/Blob_receiver concepts model.</p>
<p >Along those same lines note that the dtor (at the latest &ndash; which happens if no fatal error occurs throughout) will not only close the MQ handle acquired from <code>mq_moved</code> but will execute <code>Mq::remove_persistent(name)</code>, where <code>name == mq_moved.absolute_name()</code> pre-this-ctor.</p>
<h3>Leaks of persistent resources</h3>
<p >Notes from <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__sender.html" title="Implements Blob_sender concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message q...">Blob_stream_mq_sender</a> ctor doc header apply here.</p>
<h3>Performance</h3>
<p >The taking over of <code>mq_moved</code> should be thought of as light-weight.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">logger_ptr</td><td>Logger to use for subsequently logging. </td></tr>
    <tr><td class="paramname">mq_moved</td><td>An MQ handle to an MQ with no traffic on it so far. Unless an error is emitted, <code>mq_moved</code> becomes nullified upon return from this ctor. <code>*this</code> owns the MQ handle from this point on and is reponsible for closing it. </td></tr>
    <tr><td class="paramname">nickname_str</td><td>Human-readable nickname of the new object, as of this writing for use in <code>operator&lt;&lt;(ostream)</code> and logging only. </td></tr>
    <tr><td class="paramname">err_code</td><td>See <code>flow::Error_code</code> docs for error reporting semantics. <a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89" title="Short-hand for flow::Error_code which is very common.">Error_code</a> generated: <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297af6ee4717280d29cc272ef2a356ad3982" title="Message-queue blob stream incoming-direction peer could not be created, because one already exists at...">error::Code::S_BLOB_STREAM_MQ_RECEIVER_EXISTS</a> (another <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html" title="Implements Blob_receiver concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message...">Blob_stream_mq_receiver</a> exists), system codes (other errors, all to do with the creation of a separate internally used tiny SHM pool used to prevent duplicate <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html" title="Implements Blob_receiver concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message...">Blob_stream_mq_receiver</a> in the system). </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="blob__stream__mq__rcv_8hpp_source.html#l00327">327</a> of file <a class="el" href="blob__stream__mq__rcv_8hpp_source.html">blob_stream_mq_rcv.hpp</a>.</p>

</div>
</div>
<a id="a5ae41d506252eae388877ae8a81509d2" name="a5ae41d506252eae388877ae8a81509d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ae41d506252eae388877ae8a81509d2">&#9670;&nbsp;</a></span>Blob_stream_mq_receiver() <span class="overload">[2/4]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">ipc::transport::Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt;::Blob_stream_mq_receiver </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#aa0b92945d8282046d5fafa8230f84b93">Sync_io_obj</a> &amp;&amp;&#160;</td>
          <td class="paramname"><em>sync_io_core_in_peer_state_moved</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implements <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Blob_receiver</a> API, per its concept contract. </p>
<p >All the notes for that concept's core-adopting ctor apply.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sync_io_core_in_peer_state_moved</td><td>See above.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#a048fe523a3b315e2930029d8a6d69164" title="Default ctor: Creates a peer object in NULL (neither connected nor connecting) state.">Blob_receiver::Blob_receiver()</a>: implemented concept. </dd></dl>

<p class="definition">Definition at line <a class="el" href="blob__stream__mq__rcv_8hpp_source.html#l00336">336</a> of file <a class="el" href="blob__stream__mq__rcv_8hpp_source.html">blob_stream_mq_rcv.hpp</a>.</p>

</div>
</div>
<a id="a37990d73f81ac8c98780d19e0ddf825c" name="a37990d73f81ac8c98780d19e0ddf825c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37990d73f81ac8c98780d19e0ddf825c">&#9670;&nbsp;</a></span>Blob_stream_mq_receiver() <span class="overload">[3/4]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">ipc::transport::Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt;::Blob_stream_mq_receiver </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implements <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Blob_receiver</a> API, per its concept contract. </p>
<p >All the notes for that concept's default ctor apply.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#a048fe523a3b315e2930029d8a6d69164" title="Default ctor: Creates a peer object in NULL (neither connected nor connecting) state.">Blob_receiver::Blob_receiver()</a>: implemented concept. </dd></dl>

</div>
</div>
<a id="a6c2643bdf07b05b2ad4629ead2ae44e7" name="a6c2643bdf07b05b2ad4629ead2ae44e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c2643bdf07b05b2ad4629ead2ae44e7">&#9670;&nbsp;</a></span>Blob_stream_mq_receiver() <span class="overload">[4/4]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">ipc::transport::Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt;::Blob_stream_mq_receiver </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; &amp;&amp;&#160;</td>
          <td class="paramname"><em>src</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Move-constructs from <code>src</code>; <code>src</code> becomes as-if default-cted (therefore in NULL state). </p>
<p >Implements <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Blob_receiver</a> API, per its concept contract.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">src</td><td>See above.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#a048fe523a3b315e2930029d8a6d69164" title="Default ctor: Creates a peer object in NULL (neither connected nor connecting) state.">Blob_receiver::Blob_receiver()</a>: implemented concept. </dd></dl>

</div>
</div>
<a id="a3b2362e1945eca2e978b75151893deca" name="a3b2362e1945eca2e978b75151893deca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b2362e1945eca2e978b75151893deca">&#9670;&nbsp;</a></span>~Blob_stream_mq_receiver()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">ipc::transport::Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt;::~<a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">Blob_stream_mq_receiver</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implements <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Blob_receiver</a> API. </p>
<p >All the notes for the concept's destructor apply but as a reminder:</p>
<p >Destroys this peer endpoint which will end the one-direction pipe and cancel any pending completion handlers by invoking it ASAP with <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297afe29343445a7bf167cc186a44bd2c6ed" title="Async completion handler is being called prematurely, because underlying object is shutting down,...">error::Code::S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER</a>. As of this writing these are the completion handlers that would therefore be called:</p><ul>
<li>Any handler passed to <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#abf9cd5543b367fd68aaefc6241c9287f" title="Implements Blob_receiver API per contract.">async_receive_blob()</a> that has not yet been invoked. There can be 0 or more of these.</li>
</ul>
<h3>Fate of underlying MQ and its <code>.<a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a33770c19a8e809be10aed37f366708d8" title="Returns name equal to mq.absolute_name(), where mq was passed to ctor, at the time it was passed to c...">absolute_name()</a></code></h3>
<p >Notes from <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__sender.html" title="Implements Blob_sender concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message q...">Blob_stream_mq_sender</a> dtor doc header apply here symmetrically.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#afd3fa15abea7c11f014163c21c45d120" title="Destroys this peer endpoint which will end the conceptual incoming-direction pipe (in PEER state,...">Blob_receiver::~Blob_receiver()</a>: implemented concept. </dd></dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a33770c19a8e809be10aed37f366708d8" name="a33770c19a8e809be10aed37f366708d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33770c19a8e809be10aed37f366708d8">&#9670;&nbsp;</a></span>absolute_name()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="namespaceipc_1_1transport.html#a33de1c256addb3964b839dc2dd407d24">Shared_name</a> &amp; <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">ipc::transport::Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt;::absolute_name</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns name equal to <code>mq.absolute_name()</code>, where <code>mq</code> was passed to ctor, at the time it was passed to ctor. </p>
<p >If this object is default-cted (or moved-from), this will return <a class="el" href="classipc_1_1util_1_1Shared__name.html#a5bbfb4d3b378cf7b9a1bcaf5d6c5a067" title="A (default-cted) Shared_name. May be useful for functions returning const Shared_name&amp;.">Shared_name::S_EMPTY</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>See above. Always the same value. </dd></dl>

<p class="definition">Definition at line <a class="el" href="blob__stream__mq__rcv_8hpp_source.html#l00371">371</a> of file <a class="el" href="blob__stream__mq__rcv_8hpp_source.html">blob_stream_mq_rcv.hpp</a>.</p>

<p class="reference">References <a class="el" href="shared__name_8hpp_source.html#l00247">ipc::util::Shared_name::S_EMPTY</a>.</p>

</div>
</div>
<a id="abf9cd5543b367fd68aaefc6241c9287f" name="abf9cd5543b367fd68aaefc6241c9287f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf9cd5543b367fd68aaefc6241c9287f">&#9670;&nbsp;</a></span>async_receive_blob()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; </div>
<div class="memtemplate">
template&lt;typename Task_err_sz &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">ipc::transport::Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt;::async_receive_blob </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a> &amp;&#160;</td>
          <td class="paramname"><em>target_blob</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Task_err_sz &amp;&amp;&#160;</td>
          <td class="paramname"><em>on_done_func</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Implements <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Blob_receiver</a> API per contract. </p>
<p >Reminder: You may call this directly from within a completion handler you supplied to an earlier <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#abf9cd5543b367fd68aaefc6241c9287f" title="Implements Blob_receiver API per contract.">async_receive_blob()</a>. Reminder: It's not thread-safe to call this concurrently with other transmission methods or destructor on the same <code>*this</code>.</p>
<p ><a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89" title="Short-hand for flow::Error_code which is very common.">Error_code</a> generated and passed to <code>on_done_func()</code>: <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297afe29343445a7bf167cc186a44bd2c6ed" title="Async completion handler is being called prematurely, because underlying object is shutting down,...">error::Code::S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER</a> (destructor called, canceling all pending ops; spiritually identical to <code>boost::asio::error::operation_aborted</code>), <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297ac416e988563e44bf15fc6a81743eef53" title="User called an API with 1 or more arguments against the API spec.">error::Code::S_INVALID_ARGUMENT</a> (non-pipe-hosing error: <code>target_blob.size()</code> is smaller than <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html#ae2efe92707c53c46bc70b84f96bda217" title="Returns the max message size of the underlying queue.">Persistent_mq_handle::max_msg_size()</a>), <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297aad44f87d53255ba573d57086dfeab805" title="Will not receive message: either opposing user sent graceful-close via API.">error::Code::S_RECEIVES_FINISHED_CANNOT_RECEIVE</a> (peer gracefully closed pipe via <code>*end_sending()</code>), other system codes, indicating the underlying transport is hosed for that specific reason, as detected during incoming-direction processing.</p>
<p ><a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297adde24987f30a92b953297207ce935210" title="User protocol-code mismatch: local user-provided storage cannot fit entire message received from oppo...">error::Code::S_MESSAGE_SIZE_EXCEEDS_USER_STORAGE</a> shall never be emitted. See <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a29896e21893ae99c9f0d90a11606f819" title="Implements concept API; namely it is true.">Blob_stream_mq_receiver::S_BLOB_UNDERFLOW_ALLOWED</a>.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">Task_err_sz</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">target_blob</td><td>See above. Reminder: The memory area described by this arg must be valid up to completion handler entry. </td></tr>
    <tr><td class="paramname">on_done_func</td><td>See above. Reminder: any moved/copied version of this callback's associated captured state will be freed soon after it returns. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>See above.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#a8bc6642dbf4b5e3fdee9f3442f2bbe84" title="In PEER state: Asynchronously awaits one discrete message – as sent by the opposing peer via Blob_sen...">Blob_receiver::async_receive_blob()</a>: implemented concept. </dd></dl>

<p class="definition">Definition at line <a class="el" href="blob__stream__mq__rcv_8hpp_source.html#l00356">356</a> of file <a class="el" href="blob__stream__mq__rcv_8hpp_source.html">blob_stream_mq_rcv.hpp</a>.</p>

</div>
</div>
<a id="a444ed00ac6f4375a1bb65d0cd036b493" name="a444ed00ac6f4375a1bb65d0cd036b493"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a444ed00ac6f4375a1bb65d0cd036b493">&#9670;&nbsp;</a></span>idle_timer_run()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">ipc::transport::Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt;::idle_timer_run </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">util::Fine_duration</a>&#160;</td>
          <td class="paramname"><em>timeout</em> = <code>boost::chrono::seconds(5)</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Implements <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Blob_receiver</a> API per contract. </p>
<p >Reminder: You may call this directly from within a completion handler you supplied to an earlier <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#abf9cd5543b367fd68aaefc6241c9287f" title="Implements Blob_receiver API per contract.">async_receive_blob()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">timeout</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>See above.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#a5be288e0479a91e352fdea6d54460b22" title="In PEER state: Irreversibly enables a conceptual idle timer whose potential side effect is,...">Blob_receiver::idle_timer_run()</a>: implemented concept. </dd></dl>

<p class="definition">Definition at line <a class="el" href="blob__stream__mq__rcv_8hpp_source.html#l00364">364</a> of file <a class="el" href="blob__stream__mq__rcv_8hpp_source.html">blob_stream_mq_rcv.hpp</a>.</p>

</div>
</div>
<a id="a295c5724fedb49581506f49265d7c91a" name="a295c5724fedb49581506f49265d7c91a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a295c5724fedb49581506f49265d7c91a">&#9670;&nbsp;</a></span>nickname()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">const std::string &amp; <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">ipc::transport::Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt;::nickname</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns nickname, a brief string suitable for logging. </p>
<p >This is included in the output by the <code>ostream&lt;&lt;</code> operator as well. This method is thread-safe in that it always returns the same value.</p>
<p >If this object is default-cted (or moved-from), this will return a value equal to "".</p>
<dl class="section return"><dt>Returns</dt><dd>See above. </dd></dl>

<p class="definition">Definition at line <a class="el" href="blob__stream__mq__rcv_8hpp_source.html#l00377">377</a> of file <a class="el" href="blob__stream__mq__rcv_8hpp_source.html">blob_stream_mq_rcv.hpp</a>.</p>

<p class="reference">References <a class="el" href="ipc__core_2src_2ipc_2util_2util_8cpp_source.html#l00033">ipc::util::EMPTY_STRING</a>.</p>

</div>
</div>
<a id="a34d07384ebb52b1a5e07684817033705" name="a34d07384ebb52b1a5e07684817033705"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34d07384ebb52b1a5e07684817033705">&#9670;&nbsp;</a></span>operator=()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; &amp; <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">ipc::transport::Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt;::operator= </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; &amp;&amp;&#160;</td>
          <td class="paramname"><em>src</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Move-assigns from <code>src</code>; <code>*this</code> acts as if destructed; <code>src</code> becomes as-if default-cted (therefore in NULL state). </p>
<p >No-op if <code>&amp;src == this</code>. Implements <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Blob_receiver</a> API, per its concept contract.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a3b2362e1945eca2e978b75151893deca" title="Implements Blob_receiver API.">~Blob_stream_mq_receiver()</a>.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">src</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>*this</code>.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Blob_receiver</a> move assignment: implemented concept. </dd></dl>

</div>
</div>
<a id="a54aba7a6660a9290ca9e91c06dc18985" name="a54aba7a6660a9290ca9e91c06dc18985"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54aba7a6660a9290ca9e91c06dc18985">&#9670;&nbsp;</a></span>receive_blob_max_size()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">size_t <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">ipc::transport::Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt;::receive_blob_max_size</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Implements <a class="el" href="classipc_1_1transport_1_1Blob__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">Blob_receiver</a> API per contract. </p>
<dl class="section return"><dt>Returns</dt><dd>See above.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classipc_1_1transport_1_1Blob__receiver.html#a454ed6207aeba777f779260c142603df" title="In PEER state: Returns min target_blob.size() such that (1) async_receive_blob() shall not fail with ...">Blob_receiver::receive_blob_max_size()</a>: implemented concept. </dd></dl>

<p class="definition">Definition at line <a class="el" href="blob__stream__mq__rcv_8hpp_source.html#l00349">349</a> of file <a class="el" href="blob__stream__mq__rcv_8hpp_source.html">blob_stream_mq_rcv.hpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a65a95c466144d63ce3f7f11f554a335c" name="a65a95c466144d63ce3f7f11f554a335c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65a95c466144d63ce3f7f11f554a335c">&#9670;&nbsp;</a></span>operator&lt;&lt;()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::ostream &amp; operator&lt;&lt; </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>os</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>val</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Prints string representation of the given <code><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html" title="Implements Blob_receiver concept by using an adopted Persistent_mq_handle MQ handle to an MQ (message...">Blob_stream_mq_receiver</a></code> to the given <code>ostream</code>. </p>
<p >If object is default-cted (or moved-from), this will output something graceful indicating this.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">os</td><td>Stream to which to write. </td></tr>
    <tr><td class="paramname">val</td><td>Object to serialize. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>os</code>. </dd></dl>

<p class="definition">Definition at line <a class="el" href="blob__stream__mq__rcv_8hpp_source.html#l00385">385</a> of file <a class="el" href="blob__stream__mq__rcv_8hpp_source.html">blob_stream_mq_rcv.hpp</a>.</p>

<p class="reference">References <a class="el" href="blob__stream__mq__rcv_8hpp_source.html#l00300">ipc::transport::Blob_stream_mq_receiver&lt; Persistent_mq_handle &gt;::m_impl</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a181eb6e9705b8787bb238174da1b6e51" name="a181eb6e9705b8787bb238174da1b6e51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a181eb6e9705b8787bb238174da1b6e51">&#9670;&nbsp;</a></span>m_impl</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html#a2356c1b82f534d17e3a7a8e00023d08c">Impl_ptr</a> <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">ipc::transport::Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt;::m_impl</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The true implementation of this class. See also our class doc header. </p>

<p class="definition">Definition at line <a class="el" href="blob__stream__mq__rcv_8hpp_source.html#l00300">300</a> of file <a class="el" href="blob__stream__mq__rcv_8hpp_source.html">blob_stream_mq_rcv.hpp</a>.</p>

<p class="reference">Referenced by <a class="el" href="blob__stream__mq__rcv_8hpp_source.html#l00385">ipc::transport::Blob_stream_mq_receiver&lt; Persistent_mq_handle &gt;::operator&lt;&lt;()</a>.</p>

</div>
</div>
<a id="a29896e21893ae99c9f0d90a11606f819" name="a29896e21893ae99c9f0d90a11606f819"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29896e21893ae99c9f0d90a11606f819">&#9670;&nbsp;</a></span>S_BLOB_UNDERFLOW_ALLOWED</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">constexpr bool <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">ipc::transport::Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt;::S_BLOB_UNDERFLOW_ALLOWED = false</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implements concept API; namely it is <code>true</code>. </p>
<p >Notes for <a class="el" href="classipc_1_1transport_1_1Native__socket__stream.html" title="Implements both Native_handle_sender and Native_handle_receiver concepts by using a stream-oriented U...">transport::Native_socket_stream</a> apply.</p>
<dl class="section see"><dt>See also</dt><dd>Native_handle_receiver::S_BLOB_UNDERFLOW_ALLOWED: implemented concept. Accordingly also see "Blob underflow semantics" in <a class="el" href="classipc_1_1transport_1_1Native__handle__receiver.html" title="A documentation-only concept defining the behavior of an object capable of reliably/in-order receivin...">transport::Native_handle_receiver</a> doc header. </dd></dl>

<p class="definition">Definition at line <a class="el" href="blob__stream__mq__rcv_8hpp_source.html#l00093">93</a> of file <a class="el" href="blob__stream__mq__rcv_8hpp_source.html">blob_stream_mq_rcv.hpp</a>.</p>

</div>
</div>
<a id="ae7d533fef03e83c06b4b5071d3427bbd" name="ae7d533fef03e83c06b4b5071d3427bbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7d533fef03e83c06b4b5071d3427bbd">&#9670;&nbsp;</a></span>S_RESOURCE_TYPE_ID</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="namespaceipc_1_1transport.html#a33de1c256addb3964b839dc2dd407d24">Shared_name</a> <a class="el" href="classipc_1_1transport_1_1Blob__stream__mq__receiver.html">ipc::transport::Blob_stream_mq_receiver</a>&lt; <a class="el" href="classipc_1_1transport_1_1Persistent__mq__handle.html">Persistent_mq_handle</a> &gt;::S_RESOURCE_TYPE_ID = Mq::S_RESOURCE_TYPE_ID</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Implements concept API. Equals <code>Mq::S_RESOURCE_TYPE_ID</code>. </p>

<p class="definition">Definition at line <a class="el" href="blob__stream__mq__rcv_8hpp_source.html#l00085">85</a> of file <a class="el" href="blob__stream__mq__rcv_8hpp_source.html">blob_stream_mq_rcv.hpp</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>transport/<a class="el" href="blob__stream__mq__rcv_8hpp_source.html">blob_stream_mq_rcv.hpp</a></li>
<li>transport/<a class="el" href="transport__fwd_8hpp_source.html">transport_fwd.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:27 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
